<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>gnome-vfs-method</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GnomeVFS - Filesystem Abstraction library">
<link rel="up" href="modules.html" title="Filesystem Modules">
<link rel="prev" href="gnome-vfs-writing-modules.html" title="Writing Modules">
<link rel="next" href="gnome-vfs-2.0-gnome-vfs-module.html" title="gnome-vfs-module">
<meta name="generator" content="GTK-Doc V1.15.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="gnome-vfs-writing-modules.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="modules.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GnomeVFS - Filesystem Abstraction library</th>
<td><a accesskey="n" href="gnome-vfs-2.0-gnome-vfs-module.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#gnome-vfs-2.0-gnome-vfs-method.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#gnome-vfs-2.0-gnome-vfs-method.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="gnome-vfs-2.0-gnome-vfs-method"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="gnome-vfs-2.0-gnome-vfs-method.top_of_page"></a>gnome-vfs-method</span></h2>
<p>gnome-vfs-method</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="gnome-vfs-2.0-gnome-vfs-method.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">GnomeVFSMethod</span> *    (<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSMethodInitFunc" title="GnomeVFSMethodInitFunc ()">*GnomeVFSMethodInitFunc</a>)           (<em class="parameter"><code>const <span class="type">char</span> *method_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *config_args</code></em>);
<span class="returnvalue">void</span>                (<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSMethodShutdownFunc" title="GnomeVFSMethodShutdownFunc ()">*GnomeVFSMethodShutdownFunc</a>)       (<em class="parameter"><code><span class="type">GnomeVFSMethod</span> *method</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      (<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSMethodTruncateFunc" title="GnomeVFSMethodTruncateFunc ()">*GnomeVFSMethodTruncateFunc</a>)       (<em class="parameter"><code><span class="type">GnomeVFSMethod</span> *method</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> length</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a> *context</code></em>);
<a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      (<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSMethodTruncateHandleFunc" title="GnomeVFSMethodTruncateHandleFunc ()">*GnomeVFSMethodTruncateHandleFunc</a>) (<em class="parameter"><code><span class="type">GnomeVFSMethod</span> *method</code></em>,
                                                         <em class="parameter"><code><span class="type">GnomeVFSMethodHandle</span> *handle</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> length</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a> *context</code></em>);
#define             <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#VFS-METHOD-HAS-FUNC:CAPS" title="VFS_METHOD_HAS_FUNC()">VFS_METHOD_HAS_FUNC</a>                 (method,
                                                         func)
<span class="returnvalue">gboolean</span>            <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#gnome-vfs-method-init" title="gnome_vfs_method_init ()">gnome_vfs_method_init</a>               (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">GnomeVFSMethod</span> *    <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#gnome-vfs-method-get" title="gnome_vfs_method_get ()">gnome_vfs_method_get</a>                (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
typedef             <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform">GnomeVFSTransform</a>;
<a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform"><span class="returnvalue">GnomeVFSTransform</span></a> * <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#gnome-vfs-transform-get" title="gnome_vfs_transform_get ()">gnome_vfs_transform_get</a>             (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-method.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="gnome-vfs-2.0-gnome-vfs-method.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GnomeVFSMethodInitFunc"></a><h3>GnomeVFSMethodInitFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">GnomeVFSMethod</span> *    (*GnomeVFSMethodInitFunc)           (<em class="parameter"><code>const <span class="type">char</span> *method_name</code></em>,
                                                         <em class="parameter"><code>const <span class="type">char</span> *config_args</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>method_name</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>config_args</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSMethodShutdownFunc"></a><h3>GnomeVFSMethodShutdownFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                (*GnomeVFSMethodShutdownFunc)       (<em class="parameter"><code><span class="type">GnomeVFSMethod</span> *method</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSMethodTruncateFunc"></a><h3>GnomeVFSMethodTruncateFunc ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      (*GnomeVFSMethodTruncateFunc)       (<em class="parameter"><code><span class="type">GnomeVFSMethod</span> *method</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI"><span class="type">GnomeVFSURI</span></a> *uri</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> length</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a> *context</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>uri</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSMethodTruncateHandleFunc"></a><h3>GnomeVFSMethodTruncateHandleFunc ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-result.html#GnomeVFSResult" title="enum GnomeVFSResult"><span class="returnvalue">GnomeVFSResult</span></a>      (*GnomeVFSMethodTruncateHandleFunc) (<em class="parameter"><code><span class="type">GnomeVFSMethod</span> *method</code></em>,
                                                         <em class="parameter"><code><span class="type">GnomeVFSMethodHandle</span> *handle</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-file-size.html#GnomeVFSFileSize" title="GnomeVFSFileSize"><span class="type">GnomeVFSFileSize</span></a> length</code></em>,
                                                         <em class="parameter"><code><a class="link" href="gnome-vfs-2.0-gnome-vfs-async-ops.html#GnomeVFSContext" title="GnomeVFSContext"><span class="type">GnomeVFSContext</span></a> *context</code></em>);</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>handle</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="VFS-METHOD-HAS-FUNC:CAPS"></a><h3>VFS_METHOD_HAS_FUNC()</h3>
<pre class="programlisting">#define VFS_METHOD_HAS_FUNC(method,func) ((((char *)&amp;((method)-&gt;func)) - ((char *)(method)) &lt; (method)-&gt;method_table_size) &amp;&amp; method-&gt;func != NULL)
</pre>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>method</code></em> :</span></p></td>
<td>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-method-init"></a><h3>gnome_vfs_method_init ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            gnome_vfs_method_init               (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Initializes the gnome-vfs methods. If already initialized then will simply return
<code class="literal">TRUE</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> Returns <code class="literal">TRUE</code>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-method-get"></a><h3>gnome_vfs_method_get ()</h3>
<pre class="programlisting"><span class="returnvalue">GnomeVFSMethod</span> *    gnome_vfs_method_get                (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name of the protocol.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the method handle for the given protocol <em class="parameter"><code>name</code></em>. <em class="parameter"><code>name</code></em> could be any protocol
which gnome-vfs implements. Like ftp, http, smb etc..
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="GnomeVFSTransform"></a><h3>GnomeVFSTransform</h3>
<pre class="programlisting">typedef struct GnomeVFSTransform GnomeVFSTransform;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-vfs-transform-get"></a><h3>gnome_vfs_transform_get ()</h3>
<pre class="programlisting"><a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform"><span class="returnvalue">GnomeVFSTransform</span></a> * gnome_vfs_transform_get             (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
<p>
Get the transform for the method <em class="parameter"><code>name</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td>name of the method to get the transform of.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="gnome-vfs-2.0-gnome-vfs-method.html#GnomeVFSTransform" title="GnomeVFSTransform"><span class="type">GnomeVFSTransform</span></a> handle for <em class="parameter"><code>name</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.15.1</div>
</body>
</html>